Completed
Branch master (4da939)
by Rafael S.
03:24 queued 02:07
created

utf8-buffer.js ➔ unpack   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 1
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 3
dl 0
loc 1
rs 10
c 0
b 0
f 0
1
/*
2
 * Copyright (c) 2018 Rafael da Silva Rocha.
3
 *
4
 * Permission is hereby granted, free of charge, to any person obtaining
5
 * a copy of this software and associated documentation files (the
6
 * "Software"), to deal in the Software without restriction, including
7
 * without limitation the rights to use, copy, modify, merge, publish,
8
 * distribute, sublicense, and/or sell copies of the Software, and to
9
 * permit persons to whom the Software is furnished to do so, subject to
10
 * the following conditions:
11
 *
12
 * The above copyright notice and this permission notice shall be
13
 * included in all copies or substantial portions of the Software.
14
 *
15
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22
 *
23
 */
24
25
/**
26
 * @fileoverview Externs for utf8-buffer 0.0.1
27
 * @see https://github.com/rochars/utf8-buffer
28
 * @externs
29
 */
30
31
/**
32
 * Read a string of UTF-8 characters from a byte buffer.
33
 * Invalid characters are replaced with 'REPLACEMENT CHARACTER' (U+FFFD).
34
 * @see https://encoding.spec.whatwg.org/#the-encoding
35
 * @see https://stackoverflow.com/a/34926911
36
 * @param {!Uint8Array|!Array<!number>} buffer A byte buffer.
37
 * @param {number=} index The index to read.
38
 * @param {?number=} len The number of bytes to read.
39
 *    If len is undefined will read until the end of the buffer.
40
 * @return {string}
41
 */
42
function unpack(buffer, index=0, len=null) {}
43
44
/**
45
 * Write a string of UTF-8 characters as a byte buffer.
46
 * @see https://encoding.spec.whatwg.org/#utf-8-encoder
47
 * @param {string} str The string to pack.
48
 * @return {!Uint8Array} The packed string.
49
 */
50
function pack(str) {}
51